VoidTuber — Windows test version
================================

This is an early test build. Expect bugs, and tell Zayrix when something breaks.


1. Start it
-----------
- Unzip the whole folder somewhere permanent (for example Documents\VoidTuber). Keep all the files together.
- Double-click VoidTuber.exe.
- Windows may say "Windows protected your PC" because the app isn't signed yet:
  click "More info", then "Run anyway".


2. Add your avatar
------------------
- In the app: Avatar > "Add an avatar file..." and pick your file.
- VNyan / VSeeFace avatars (.vsfavatar) work as they are.
- VRChat avatars: export them from their Unity project with the VoidTuber exporter 0.5.0 or newer
  (Tools > VoidTuber > Avatar Exporter; versions before 0.5.2 say Tools > VTuber Linux). Its files work on Windows and Linux, whichever OS you export on.
  Files from older exporters (0.3 and before) only work on Linux.
- Your avatars are kept in %LOCALAPPDATA%\vtube-linux\avatars ("Open folder" in the Avatar window opens it).


3. Get it into OBS
------------------
Picture (with transparency):
- Install the OBS Spout2 plugin: https://github.com/Off-World-Live/obs-spout2-plugin/releases
- In OBS: Sources > + > Spout2 Capture > pick the camera name the app shows
  (Integrations > OBS in the app tells you the exact name).
Sound (dance music, soundboard, props):
- In OBS: Sources > + > Application Audio Capture > pick the VoidTuber window.
Press Tab to hide the interface while you're live.


4. Webcam tracking
------------------
- Tracking > Webcam: switch it on and pick your camera. It tracks face, hands and upper body.
- Look straight at the camera for a moment when it starts (it calibrates), or press Recalibrate.
- On Windows only one program can use a webcam at a time: if OBS (or Discord, etc.) shows your webcam,
  the app can't get pictures from it. Close it there first.
- Keep the "tracker" folder next to VoidTuber.exe: the tracker lives in there.


5. Updates
----------
The app checks for updates by itself and asks before installing one (or: Settings > Check for updates).
The new version is put in place when you restart or close the app. Your settings and avatars are kept
(they live in %APPDATA% and %LOCALAPPDATA%, not in this folder). Keep the folder somewhere you can write to,
like Documents (not Program Files), or updates can't be installed.


6. Not in the Windows version yet
---------------------------------
- AudioLink (avatars reacting to music)
- Virtual webcam output (use OBS's own Virtual Camera instead)

Collabs, props, redeems, toggles, dances, Twitch and Discord all work.


Help
----
Press F1 in the app, or read https://voidtuber.app/docs/
(the help pages are written for Linux; most of it works the same on Windows).
